Skip to content

HADOOP-185768. followup#5376

Closed
steveloughran wants to merge 1 commit intoapache:trunkfrom
steveloughran:build/HADOOP-185768-javadoc-11
Closed

HADOOP-185768. followup#5376
steveloughran wants to merge 1 commit intoapache:trunkfrom
steveloughran:build/HADOOP-185768-javadoc-11

Conversation

@steveloughran
Copy link
Contributor

@steveloughran steveloughran commented Feb 9, 2023

Add javadoc to
hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/recovery/package-info.java

How was this patch tested?

waiting for yetus

For code changes:

  • Does the title or this PR starts with the corresponding JIRA issue id (e.g. 'HADOOP-17799. Your PR title ...')?
  • Object storage: have the integration tests been executed and the endpoint declared according to the connector-specific documentation?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE, LICENSE-binary, NOTICE-binary files?

@steveloughran
HADOOP-185768. followup
b060b73 
Add javadoc to
hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/recovery/package-info.java

Change-Id: I1919250e010c8d1b311a7378f5b2bad89602b529
@steveloughran
Copy link
Contributor Author

steveloughran commented Feb 9, 2023

followup to #5344

@ayushtkn
Copy link
Member

ayushtkn commented Feb 9, 2023

Tried this PR as well, some more work, need to do at bunch of more places, for the entire trunk javadoc build to be green.

ublic
[ERROR] @InterfaceAudience.Public
[ERROR] ^
[ERROR] /home/ayushsaxena/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/async/impl/package-info.java:18: error: unknown tag: InterfaceAudience.Public
[ERROR] @InterfaceAudience.Public
[ERROR] ^
[ERROR] /home/ayushsaxena/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/impl/package-info.java:18: error: unknown tag: InterfaceAudience.Public
[ERROR] @InterfaceAudience.Public
[ERROR] ^
[ERROR] /home/ayushsaxena/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/cli/package-info.java:18: error: unknown tag: InterfaceAudience.Public
[ERROR] @InterfaceAudience.Public
[ERROR] ^
[ERROR] /home/ayushsaxena/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/util/package-info.java:18: error: unknown tag: InterfaceAudience.Public
[ERROR] @InterfaceAudience.Public
[ERROR] ^
[ERROR] 
[ERROR] Command line was: /usr/lib/jvm/java-11-openjdk-amd64/bin/javadoc @options @packages
[ERROR] 
[ERROR] Refer to the generated Javadoc files in '/home/ayushsaxena/hadoop/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/target/site/apidocs' dir.
[ERROR] 
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] 
[ERROR] After correcting the problems, you can resume the build with the command
[ERROR]   mvn <args> -rf :hadoop-yarn-client
ayushsaxena@a289af3c944f:~/hadoop$

Steps to repro are mentioned over here, so If you are trying to validate locally can follow that:
#5226 (review)

@hadoop-yetus
Copy link

hadoop-yetus commented Feb 9, 2023

💔 -1 overall

Vote Subsystem Runtime Logfile Comment
+0 🆗 reexec 0m 56s Docker mode activated.
_ Prechecks _
+1 💚 dupname 0m 0s No case conflicting files found.
+0 🆗 codespell 0m 1s codespell was not available.
+0 🆗 detsecrets 0m 1s detect-secrets was not available.
+1 💚 @author 0m 0s The patch does not contain any @author tags.
-1 ❌ test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch.
_ trunk Compile Tests _
+1 💚 mvninstall 45m 26s trunk passed
+1 💚 compile 1m 9s trunk passed with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04
+1 💚 compile 1m 2s trunk passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08
+1 💚 checkstyle 0m 51s trunk passed
+1 💚 mvnsite 1m 5s trunk passed
-1 ❌ javadoc 0m 57s /branch-javadoc-hadoop-yarn-project_hadoop-yarn_hadoop-yarn-server_hadoop-yarn-server-resourcemanager-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04.txt hadoop-yarn-server-resourcemanager in trunk failed with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04.
+1 💚 javadoc 0m 44s trunk passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08
+1 💚 spotbugs 2m 11s trunk passed
+1 💚 shadedclient 26m 27s branch has no errors when building and testing our client artifacts.
_ Patch Compile Tests _
+1 💚 mvninstall 1m 1s the patch passed
+1 💚 compile 1m 6s the patch passed with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04
+1 💚 javac 1m 6s the patch passed
+1 💚 compile 0m 54s the patch passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08
+1 💚 javac 0m 54s the patch passed
+1 💚 blanks 0m 0s The patch has no blanks issues.
+1 💚 checkstyle 0m 42s hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager: The patch generated 0 new + 0 unchanged - 1 fixed = 0 total (was 1)
+1 💚 mvnsite 0m 58s the patch passed
+1 💚 javadoc 0m 44s hadoop-yarn-project_hadoop-yarn_hadoop-yarn-server_hadoop-yarn-server-resourcemanager-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 with JDK Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 generated 0 new + 99 unchanged - 2 fixed = 99 total (was 101)
+1 💚 javadoc 0m 40s the patch passed with JDK Private Build-1.8.0_352-8u352-ga-1~20.04-b08
+1 💚 spotbugs 2m 11s the patch passed
+1 💚 shadedclient 26m 9s patch has no errors when building and testing our client artifacts.
_ Other Tests _
+1 💚 unit 105m 21s hadoop-yarn-server-resourcemanager in the patch passed.
+1 💚 asflicense 0m 32s The patch does not generate ASF License warnings.
220m 26s
Subsystem Report/Notes
Docker ClientAPI=1.42 ServerAPI=1.42 base: https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5376/1/artifact/out/Dockerfile
GITHUB PR #5376
Optional Tests dupname asflicense compile javac javadoc mvninstall mvnsite unit shadedclient spotbugs checkstyle codespell detsecrets
uname Linux 689e288ffec7 4.15.0-200-generic #211-Ubuntu SMP Thu Nov 24 18:16:04 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
Build tool maven
Personality dev-support/bin/hadoop.sh
git revision trunk / b060b73
Default Java Private Build-1.8.0_352-8u352-ga-1~20.04-b08
Multi-JDK versions /usr/lib/jvm/java-11-openjdk-amd64:Ubuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 /usr/lib/jvm/java-8-openjdk-amd64:Private Build-1.8.0_352-8u352-ga-1~20.04-b08
Test Results https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5376/1/testReport/
Max. process+thread count 948 (vs. ulimit of 5500)
modules C: hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager U: hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager
Console output https://ci-hadoop.apache.org/job/hadoop-multibranch/job/PR-5376/1/console
versions git=2.25.1 maven=3.6.3 spotbugs=4.2.2
Powered by Apache Yetus 0.14.0 https://yetus.apache.org

This message was automatically generated.

@ayushtkn
Copy link
Member

ayushtkn commented Feb 9, 2023

Just about the Javadoc result why it is green here:

hadoop-yarn-project_hadoop-yarn_hadoop-yarn-server_hadoop-yarn-server-resourcemanager-jdkUbuntu-11.0.17+8-post-Ubuntu-1ubuntu220.04 with JDK Ubuntu-11.0.17+8-post-Ubuntu

Because it just runs for the touched module not for the entire code. That is why hadoop-common build also had a green Javadoc build.

@steveloughran
Copy link
Contributor Author

steveloughran commented Feb 9, 2023

if its a whole yarn module i'm going to stop working on this right now...too many other things i'm afraid. if someone else takes it up, i will review

@ayushtkn
Copy link
Member

ayushtkn commented Feb 9, 2023

too many other things i'm afraid

🙂
That is why I was telling, doing module by module is very time consuming, won't say it isn't a good thing to do but requires effort, and if we can just ignore this annotation asking for Javadoc like I said over here(#5226 (review)) on your original PR, it was one pass for all and we would have been sorted, obviously if it worked over here on Jenkins as well. I just tried locally.

There are some PR's I was tagged on them fixing Javadocs in some or the other modules, I will mark you, I am not very confident with all the Yarn classes to say if those Javadocs are very correct or not.

Thanx for volunteering and giving it a shot :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@steveloughran @ayushtkn @hadoop-yetus